refactor!: rename ScanData to ScanMetadata#817
Merged
zachschuermann merged 6 commits intodelta-io:mainfrom Apr 9, 2025
Merged
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #817 +/- ##
==========================================
+ Coverage 84.87% 84.89% +0.02%
==========================================
Files 83 83
Lines 20311 20316 +5
Branches 20311 20316 +5
==========================================
+ Hits 17239 17248 +9
+ Misses 2221 2219 -2
+ Partials 851 849 -2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
ScanData to ScanFilesScanData to ScanMetadata
nicklan
approved these changes
Apr 9, 2025
Member
nicklan
left a comment
There was a problem hiding this comment.
nice. Just a few more places where we call this "scan data":
kernel/tests/golden_tables.rs
276: let mut scan_metadata = scan.scan_metadata(&engine).expect("scan data");
292: let scan_metadata: Vec<_> = scan.scan_metadata(&engine).expect("scan data").collect();
kernel/src/table_changes/scan_file.rs
81:/// for res in scan_metadata { // scan data table_changes_scan.scan_metadata()
kernel/src/table_changes/scan.rs
183: /// deletion vectors present in the commit. The engine data in each scan data is guaranteed
ffi/src/scan.rs
178:/// Call the provided `engine_visitor` on the next scan data item. The visitor will be provided with
kernel/src/table_changes/log_replay.rs
30:/// Scan data for a Change Data Feed query. This holds metadata that is needed to read data rows.
ffi/examples/read-table/read_table.c
86:// For each chunk of scan data (which may contain multiple files to scan), kernel will call this
297: print_error("Failed to construct scan data iterator.", (Error*)data_iter_res.err);
304: print_diag("\nIterating scan data\n");
311: print_error("Failed to iterate scan data.", (Error*)ok_res.err);
315: print_diag("Scan data iterator done\n");
kernel/src/scan/state.rs
155:/// for res in scan_metadata { // scan data from scan.scan_metadata()
sebastiantia
approved these changes
Apr 9, 2025
Collaborator
There was a problem hiding this comment.
looks good, found some neglected architecture doc that i had no idea existed
delta-kernel-rs/doc/architecture.md
Line 89 in 8961e97
scovich
approved these changes
Apr 9, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changes are proposed in this pull request?
Rename
ScanDatatoScanMetadataandScan::scan_datatoScan::scan_metadata(and corresponding FFI). Additionally, renamesTableChangesScanDatatoTableChangesScanMetadata. Additional docs/refactor coming in #768This PR affects the following public APIs
breaking changes:
ScanDatatoScanMetadataScan::scan_data()toScan::scan_metadata()free_kernel_scan_data()tofree_scan_metadata_iter()kernel_scan_data_next()toscan_metadata_next()visit_scan_data()tovisit_scan_metadata()kernel_scan_data_init()toscan_metadata_iter_init()KernelScanDataIteratortoScanMetadataIteratorSharedScanDataIteratortoSharedScanMetadataIteratorHow was this change tested?
existing
resolves #816